Pular para o conteúdo principal

Consulta de transações

Este endpoint retorna todas as transações efetivas na conta bancária.

Requisição

GET 'https://apisandbox.delbank.com.br/baas/api/v2/transactions'

Headers

NomeDescrição
x-delbank-api-keyObrigatório. Chave de API

Parâmetros Query:

NomeTipoDescrição
pagenumberNúmero de página (paginação)
Default: 1
limitnumberContagem de itens retornados (paginação)
Default: 10
nsunumberNSU (Número Sequencial Único) da transação.
Se a transação existir, o endpoint retornará apenas 1 transação
isCreditbooleanUtilize true ou false
Se informado, filtrará as transações de acordo com seu tipo, seja crédito ou débito. Se não informado, todas as transações serão retornadas independentemente da modalidade
typearray|enumTipo de transação. Pode ser informado de uma lista de tipos de transação.
startDatedateData de início da criação da transação. A data de início será considerada de acordo com o padrão UTC, ou seja, ao inserir 2023-01-01, as transações que foram criadas a partir de 2023-01-01 03:00:00.000Z serão retornadas.
endDatedateData final de criação da transação. Ao aplicar este filtro, a data inicial será considerada de acordo com o padrão UTC, ou seja, ao inserir 2023-01-01, as transações que foram criadas até 2023-01-01 03:00:00.000Z serão retornadas.
transactionIdstringEndToEndId da transferência/pagamento no contexto do Pix.
Este filtro tem como objetivo facilitar a busca por pagamentos (cash-out) e recebimentos (cash-in) do Pix. Caso a transação exista, ele retornará apenas uma transação.

Tipos de Transação

TipoDescriçãoModalidade (crédito ou débito)
DEBIT_TRANSFER_INTERNALTransferência enviada (transferência entre contas Debank)Débito
CREDIT_TRANSFER_INTERNALTransferência recebida (transferência entre contas Delfinance)Crédito
DEBIT_TRANSFER_EXTERNALTED enviadoDébito
CREDIT_TRANSFER_EXTERNALTED recebidoCrédito
DEBIT_PIXPix enviadoDébito
CREDIT_PIXPix recebidoCrédito

Exemplos

# Consultando todas as transações
GET 'https://apisandbox.delbank.com.br/baas/api/v2/transactions'

# Consultando transações de crédito
GET 'https://apisandbox.delbank.com.br/baas/api/v2/transactions?isCredit=true'

# Consultando transação por NSU
GET 'https://apisandbox.delbank.com.br/baas/api/v2/transactions?nsu=999998'

# Filtragem por tipo de transação
GET 'https://apisandbox.delbank.com.br/baas/api/v2/transactions?type=CREDIT_PIX'

# Consultando diferentes tipos de transações
GET 'https://apisandbox.delbank.com.br/baas/api/v2/transactions?type=CREDIT_PIX&type=DEBIT_PIX'

Resposta

[
{
"id": "21E3822485720230827144231555972751",
"nsu": 727646,
"amount": 5.00,
"notes": "description",
"createdAt": "2023-08-27T14:42:34.763Z",
"type": {
"name": "CREDIT_PIX",
"description": "PIX recebido",
"isCredit": true
},
"balance": {
"balancePrevious": 69696969687968.55,
"currentBalance": 69696969687973.55
},
"proof": {} // generic response
}
]
Note

🚧 O campo proof é uma informação genérica que pode diferir dependendo do tipo de transação. Este campo representa a prova da transação

Comprovante Pix

[
{
"id": "21E3822485720230827144231555972751",
"correlationId": "1f9d63e8-81f6-4636-b862-e2edf4c72d67",
"nsu": 727646,
"amount": 5.00,
"notes": "description",
"createdAt": "2023-08-27T14:42:34.763Z",
"type": {
"name": "CREDIT_PIX",
"description": "PIX recebido",
"isCredit": true
},
"balance": {
"balancePrevious": 69696969687968.55,
"currentBalance": 69696969687973.55
},
"proof": {
"endToEndId": "E3822485720230827144231555972751",
"status": "PIX_EFFECTIVE",
"type": "PIX_QR_CODE_DYNAMIC",
"amount": 5.0,
"description": "description",
"payer": {
"number": "31712",
"branch": "0001",
"type": "CURRENT",
"holder": {
"document": "32752023000149",
"name": "bxxdbde",
"type": "LEGAL"
},
"participant": {
"name": "DELCRED SCD S.A.",
"ispb": "38224857"
}
},
"beneficiary": {
"number": "31712",
"branch": "0001",
"type": "CURRENT",
"holder": {
"document": "32752023000149",
"name": "bxxdbde",
"type": "LEGAL"
},
"participant": {
"name": "DELBANK",
"ispb": "38224857"
}
}
}
}
]